FE3H Access, version 0.2.3 (preview)
====================================

FE3H Access makes Fire Emblem: Three Houses playable with a screen reader. It runs beside the Eden emulator, reads what the game
shows, and speaks it through your screen reader: menus, dialogue, battles, the monastery, and more. It also adds sounds and keys to
find your way: a pathfinder for battles and for walking around the monastery, a beacon, automatic walking, and wall sounds.

It only reads. It never changes the game, its saves, or Eden's memory, and it doesn't use the internet.


What you need
-------------

1. Windows 10 or 11, 64-bit.
2. The Eden emulator. FE3H Access was made and tested with Eden version 0.2.1.
3. Your own copy of Fire Emblem: Three Houses, the US version, with update 1.2.0 installed in Eden. Other regions and versions are not
   supported yet: FE3H Access then says "unsupported game version". The Cindered Shadows DLC is supported, but not needed.
4. A screen reader. NVDA is tested. JAWS and others should work through the same speech library (Prism). Without one, a Windows voice
   speaks, and when your screen reader starts again, FE3H Access goes back to it by itself.


Installing
----------

1. Unzip the whole "FE3H Access" folder somewhere you can write to, for example your Documents folder or your Desktop. Keep every file
   together, and keep it out of the folders Eden looks for games in: Eden reloads its game list when files change there, and that can
   crash it in the middle of a game. FE3H Access tells you if it finds itself in one.
2. Do the Eden setup below once.
3. Start FE3HAccess.exe. You hear "FE3H Access started."

Windows may say "Windows protected your PC" the first time. Choose "More info", then "Run anyway". Windows shows this for every new
program that isn't signed with a paid certificate.


Setting up Eden (once)
----------------------

1. Eden's own volume keys are minus and equals, which FE3H Access uses for its lists. Move them away:
   Close Eden, then run "Set up Eden keys.bat" from the FE3H Access folder. It moves Eden's volume keys to Control+Shift+minus and
   Control+Shift+equals, saves a backup of Eden's settings beside them, and tells you when it's done. Press Enter to close it.
   If it says Eden's settings weren't found, start Eden once, close it, and run it again. For a portable Eden (Eden with its own "user"
   folder), drag Eden's folder onto "Set up Eden keys.bat".
   To do it by hand instead: in Eden, open Emulation, Configure, and the Hotkeys page. Find "Audio Volume Down", double-click its
   keyboard key and press Control+Shift+minus; then "Audio Volume Up" with Control+Shift+equals. Choose OK.
2. Keep Eden's keyboard controls for player 1 at their defaults, even if you play with a controller (see "Controller" below). FE3H
   Access's automatic walking presses Eden's movement keys W, A, S, D and Shift for you.
3. If you type in a language other than English, switch to English while Eden's window is in front. Otherwise Eden ignores the letter
   keys (the game's buttons), and automatic walking can't move.


Playing
-------

Start Eden and the game, and FE3HAccess.exe, in any order. When the game is running you hear "Connected to Fire Emblem Three Houses."
FE3H Access's keys work while Eden is the window in front. To quit FE3H Access, press Control+Shift+Q in Eden, or close its window.


FE3H Access's keys
------------------

Everywhere:
- F1: the mod menu (see below).
- Shift+P: repeat the last line.
- Shift+[ and Shift+]: step back and forward through what was said.
- O twice: the dialogue on or off. When it is off, conversations aren't spoken, but Shift+P and Shift+[ and Shift+] still read them.
- Control+Left and Control+Right: the previous and next part of a big panel (a unit's details, a shop item, the battle forecast, the
  unit under the cursor).
- Control+Up and Control+Down: one item at a time inside that part.
- Control+Shift+H: the scene descriptions on or off. They are on at first: while a movie plays (a cutscene, the opening, a month's
  storybook picture), FE3H Access says what the screen shows, at its moment.
- Control+Shift+Q: quit FE3H Access.

In a battle:
- Minus and equals: the pathfinder's categories (enemies, the third army, allies, chests, healing squares, objects, target
  destinations). Home and End do the same.
- [ and ]: the items in the category, nearest first. Page Up and Page Down do the same.
- Control+[ and Control+]: the first and last item.
- Control+minus and Control+equals: the first and last category that has something.
- P: how far it is from the cursor, in arrow keys.
- P twice: guidance as you move the cursor. With a unit picked, it leads to where that unit stops this turn.
- Backslash: the whole path. With a unit picked, its route turn by turn. When enemies stand in every way there, it says "No route" and
  names them, for example "No route. Rogue, Fighter at 17, 15 blocks the way." Units can't walk through enemies.
- O: the scanner. Everything within 5 squares of the cursor, nearest first.
- Apostrophe: the terrain of the cursor's square.
- The directions are the arrow keys to press. They turn with the camera (J and L), and the camera's turn is said.
- Sounds: a soft rising sound on each square the picked unit can move to, and a low sound on danger squares while the danger area is
  shown (ZR). Showing or hiding it says "Danger Area on" or "Danger Area off".
- In thick fog, only the enemies the game shows are read; a square in the fog says "Out of Sight".

In the monastery:
- Minus, equals, [ and ]: the pathfinder's lists: places, people, quests, objects, items and exits. People lists the named characters
  first, then the others who talk when you press A, then the ones who only chat. A person with a quest's mark says it after their name:
  "quest giver" (a quest you can take), "quest" (a quest you took sends you to them), "quest report". Quests lists only those people.
  A place's People also has everyone the map lists there; one standing just outside says where: "Mercedes, Cemetery, 43 steps, left".
- The map (R): each place says who is there and the quest marks the map shows ("1 quest mark: Priest"). X (Locate) reads the people
  one by one with Up and Down, with "not talked to" for someone you haven't talked to today and "Faculty Training" where it's offered;
  ZR shows the place's description and its resources ("Resources: Fishkeeper"). Control+Right on a place: its Occupants, then its
  Quests.
- A soft rising chime: A does something here (talk to someone, read or open something, take a stair or a door, pick up an item). Walk
  up to a person who has a speech bubble and the bubble is read; someone who only chats gets the line without the chime.
- While you walk, the people you can talk to make a sound from where they are.
- P: the beacon, a sound from where the chosen thing is.
- P twice: the turn-by-turn beacon.
- Backspace: walk to the chosen thing by itself. Backspace again stops.
- O: the wall sounds on or off.
- Apostrophe: the date, where you are, your activity points, your professor level and your quests' goals, with the quests the
  screen reminds you to take.
- Fishing: when a fish bites, its colour is said as it jumps up by the line (blue, light blue, red or yellow), as the screen shows it.
- Tea time: your guest's lines, "Offer some tea", "Talk! Round 1 of 3", then the three topics (or, at the end, the three reactions)
  all at once, then the one you're on as you move. Both choices are timed: a soft tick each second for the last 5 seconds
  (tick_volume in the settings), and Ctrl+Right tells the seconds left.


The mod menu
------------

Press F1 while Eden is in front. The mod menu is spoken, nothing is drawn, and while it is open the game doesn't get your keys.
- Up and Down move through the tabs: Audio, General, Controls and Restore defaults. Enter opens one.
- Inside a tab, Up and Down move through the items. Each says its value and what it does.
- Left and Right change the item: a sound's volume goes down or up by 10 (0 is off, 200 is twice as loud), and you hear the sound at
  its new volume; a switch goes off with Left and on with Right. Enter also turns a switch on or off.
- Escape goes back. From the tabs it closes the menu. F1 closes it from anywhere.
- Audio: every sound's volume, the battle's danger and move sounds, and the fishing beats' timing.
- General: the scene descriptions, the dialogue, the wall sounds, the info buffers (Control+arrows) and the Windows voice.
- Controls: every key, in two lists, Keyboard and Controller, each in sections. Left and Right jump between sections.
- Restore defaults: press Enter twice to put every setting back.
Every change is saved at once, so the next start is the same. O (the wall sounds), O twice (the dialogue) and Control+Shift+H (the
scene descriptions) are saved the same way.


Controller
----------

FE3H Access can take an Xbox-style controller (XInput) and pass it to Eden for you, adding its own buttons. Eden's player 1 must stay on
the keyboard: if Eden reads the controller itself, every press would count twice, so FE3H Access then leaves the controller alone and
tells you. FE3H Access presses the keys you gave player 1 in Eden. The controller works while Eden is the window in front. Every
XInput controller connected is read, so on a handheld (a ROG Ally, a Legion Go) it doesn't matter which of its controllers takes your
presses: its own or a virtual one from a tool such as Handheld Companion or Steam. Eden only takes its letter keys from an English-style
keyboard layout (with Arabic, for example, it ignores them), so when Eden's window uses another layout FE3H Access switches Eden's
window to an English layout you have installed before it presses a letter. Your other windows keep their layout.
- The buttons are named as on a Switch controller, by their place, whatever your controller's labels say: A is the right button, B
  the bottom one, X the top one and Y the left one. L and R are the shoulder buttons, ZL and ZR the triggers, Minus and Plus the two
  small middle buttons (Back and Start on an Xbox controller).
- The game gets them as on a Switch. The sticks move in 8 directions; a half push of the left stick walks slowly.
- ZL and ZR are the game's when you press one alone: the game gets it when you let go. Held, they turn the other buttons into FE3H
  Access's:
- ZR and the d-pad: the info buffers (Left and Right the previous and next part, Up and Down one item). ZR and B: the terrain in a
  battle, the status line in the monastery. ZR and Y: stop speaking.
- ZL and the d-pad: the pathfinder's lists (Left and Right the categories, Up and Down the items). ZL and L or R: the first or last
  item. ZL and X: the beacon in the monastery, how far in a battle (twice: turn by turn, or guidance). ZL and A: the wall sounds on or
  off in the monastery, the scanner in a battle. ZL and B: the whole path. ZL and pressing the left stick: walk to the chosen thing by
  itself.
- ZL, ZR and the d-pad: Left and Right step through what was said, Up repeats the last line, Down turns the dialogue on or off. ZL, ZR
  and Plus: the mod menu, where the d-pad moves, A opens, B goes back and Plus closes.
The mod menu's Controls tab has the whole list, and its General tab turns the controller off.


The game's buttons on Eden's keyboard
-------------------------------------

Eden's default keys for player 1:
- A button: C key.
- B button: X key.
- X button: V key.
- Y button: Z key.
- L button: Q key.
- R button: E key.
- ZL button: R key.
- ZR button: T key.
- Plus button: M key.
- Minus button: N key.
- Left stick: W, A, S and D keys. Hold Shift for a slow push.
- Right stick: I, J, K and L keys.
- D-pad: the arrow keys.


Settings
--------

On the first start FE3H Access writes fe3h-access.ini beside FE3HAccess.exe (or, when that folder can't be written, in your
AppData\Local\FE3H Access folder). The mod menu (F1) changes the sounds and the switches and saves them there. To change the keys,
open it with Notepad: each setting has a line explaining it. Restart FE3H Access after a change in Notepad.


Exact walls
-----------

The wall sounds in the monastery and the Abyss follow the game's own walls. FE3H Access reads them straight from your game through
Eden: it finds the game in Eden's game folders or among what you installed into Eden, and opens it with the keys you gave Eden.
Nothing to set up, and nothing is copied. The Abyss needs the Cindered Shadows DLC in Eden. If FE3H Access can't find the files, the
wall sounds use a coarser map, and the log says why.


Logs and saves
--------------

If we ask for them to look into a problem:
- The log: fe3h-access.log in the FE3H Access folder (or in your AppData\Local\FE3H Access folder, when FE3H Access couldn't write in
  its own folder). It starts over every time FE3H Access starts, so copy it before starting FE3H Access again.
- The saves: in Eden's game list, open the context menu on Fire Emblem: Three Houses and choose "Open Save Data Location". They are in
  your AppData\Roaming\eden\nand\user\save folder, in a folder named 010055D009F78000.


When something goes wrong
-------------------------

- Nothing is said: check that your screen reader runs. The log (see "Logs and saves") shows what happened.
- "Unsupported game version": FE3H Access needs the US version of the game with update 1.2.0.
- Minus or equals changes Eden's volume: run "Set up Eden keys.bat" with Eden closed.
- The letter keys do nothing in the game: switch Eden's window to English.


Thanks
------

Made by Haru.
Website: heavenay.com
The beacon, arrival, list and turn sounds are by Saul (Discord: msaul).
FE3H Access uses Prism, NAudio and .NET: see THIRD-PARTY-NOTICES.txt and the licenses folder.

FE3H Access is a fan-made accessibility tool. It is not made or endorsed by Nintendo, Intelligent Systems or Koei Tecmo. Fire Emblem:
Three Houses is their game: you need your own copy.
